Fix Parsing of Multiline Argument Descriptions #527
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wojtekn
requested changes
Jul 9, 2024
There was a problem hiding this comment.
@shreya0204 thanks for your contribution.
I think this change may need more work and possibly, another approach:
- does the current approach cover multi-line comments that can occur inside
{}block? - isn't it too greedy now? It uses a comma
,to start a param block, and looks for}to reach the end?
bin/command.php
Outdated
| @@ -630,7 +630,9 @@ private static function parse_docblock( $docblock ) { | |||
| $key = key( $ret['parameters'][ $param_name ] ); | |||
| reset( $ret['parameters'][ $param_name ] ); | |||
| if ( ! empty( $ret['parameters'][ $param_name ][ $key ][2] ) | |||
| && '{' === substr( $ret['parameters'][ $param_name ][ $key ][2], -1 ) ) { | |||
| && | |||
| in_array( substr( $ret['parameters'][ $param_name ][ $key ][2], -1 ), [ '{', ',' ], true ) | |||
There was a problem hiding this comment.
What will happen if a multi-line comment doesn't end with a comma?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #477
This pull request addresses a parsing error in the WP CLI handbook where multiline argument descriptions in the
Utils\http_request()method were not being handled correctly. Previously, the parser failed to recognize,as a valid character that could indicate the continuation of an argument description onto a new line.Changes Made:
Updated the conditional check in the parsing logic. Now, the parser recognizes both
{and,characters as potential indicators of a multiline argument. This ensures that argument descriptions that continue after these characters are correctly parsed and included in the documentation.